GitLab CI Kotlin DSL/opensavvy.gitlab.ci.plugins/Docker

Docker

Integrate Docker into your build.

This plugin is responsible for adding the docker extension to scripts:

val dockerBuild by job {
    useDockerInDocker()
    useContainerRegistry()

    script {
        docker.build("backend")
    }
}

Job extensions

This plugin provides the following job extensions:

useDockerInDocker: configure the Docker In Docker service,
useContainerRegistry: logs in to the GitLab Container Registry of the current project.

Types

Companion

object Companion

Functions

build

fun build(image: String, version: String = "build-", dockerfile: String = "Dockerfile", context: String = ".", previousVersions: List<String> = listOf("latest")): <Error class: unknown class>

Builds a Docker image from a Dockerfile.

logInToRegistry

fun logInToRegistry(registry: String, username: String, password: String): <Error class: unknown class>

Logs in to an arbitrary container registry.

pull

fun pull(image: String, version: String = "latest", allowFailure: Boolean = false): <Error class: unknown class>

Pulls a given image's version.

push

fun push(image: String, version: String = "build-"): <Error class: unknown class>

Pushes the image to a container registry.

rename

fun rename(image: String, oldVersion: String = "build-", newVersion: String = "latest"): <Error class: unknown class>

Renames a version of an image.